TransactionBusinessRulePacket

Description

In order to provide additional functionality to the transactions, individual business rules can be created/overridden at the appropriate transaction level and attached to the transaction via the TransactionBusinessRulePacket business rule.  All the business rules used by the transactions should be listed in the TransactionBusinessRulePacket business rule. This list of rules controls the order in which the rules attached to a transaction are processed.

 

Some business rules are exceptions since they do not require transaction processing (i.e., ActivitySummary, FundListForAllocation, ReportFile, ReportDetails, TransactionCosmetics, DisbursementNumber, ReverseScreen and SummaryFields).  They should not be listed in the TransactionBusinessRulePacket.

TransactionBusinessRulePacket Element/Attribute Table

Element/Tag

Definition

Attribute

Element/Attribute Value and Description

<TransactionBusinessRulePacket>

The opening and closing tag for the business rule.

 

 

    <Rule>

Required and repeatable element;
<Rule>
tag is used to mention the name of the business rule that is to be executed when the transaction is processed.

 

 

 

 

OVERRIDABLE

 

 

 

 

 

 

 

 

 

ERRORSTATUSCODE

 

 

 

 

 

 

 

 

 

 

 

 

IF

Required element value;
BusinessRuleName:
 Name of the business rule that needs to be attached to the transaction.

 

String; Optional attribute;

This attribute is used to indicate whether the transaction processing can be continued or not when the attached business rules results in an error.

 

Required attribute value;

Auto - Defines the ability to Auto override. If set to "Auto" errors will be auto overridden.

 

Optional attribute;

Code (as defined in AsCodeErrorStatus) is the number assigned to the ERRORSTATUSCODE.

 

Example:

ERRORSTATUSCODE="02" - Error/Errors in Activity.

ERRORSTATUSCODE="01" - No Errors or not processed yet.

ERRORSTATUSCODE="03" - Warning/Activity Processed successfully but there were warnings.

 

Optional attribute;

Defines the condition to be satisfied in order to execute the attached business rule during  transaction processing.

 

 

 XML Example

<TransactionBusinessRulePacket>

<Rule>StatusChange</Rule>

<Rule>CreatePolicy</Rule>

<Rule>CopyToSegmentFields</Rule>

</TransactionBusinessRulePacket>

 

 Schema Example

<TransactionBusinessRulePacket>

<Rule>BusinessRuleName</Rule>

</TransactionBusinessRulePacket>